<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SpringVaadinServlet.html 906 2014-07-30 00:09:06Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.server.DeploymentConfiguration;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.vaadin.server.ServiceException;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import com.vaadin.server.VaadinRequest;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import com.vaadin.server.VaadinServlet;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import com.vaadin.server.VaadinServletService;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import com.vaadin.server.VaadinSession;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.util.ArrayList;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.util.List;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Properties;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.WeakHashMap;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import javax.servlet.ServletConfig;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import javax.servlet.ServletException;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * A {@link VaadinServlet} that associates and manages a Spring<a name="line.26"></a>
<span class="sourceLineNo">027</span> * {@link org.springframework.web.context.ConfigurableWebApplicationContext} with each<a name="line.27"></a>
<span class="sourceLineNo">028</span> * {@link com.vaadin.server.VaadinSession} (aka, "Vaadin application" in the old terminology).<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * The {@code vaadinContextConfigLocation} servlet parameter may be used to specify the Spring XML config<a name="line.31"></a>
<span class="sourceLineNo">032</span> * file location(s). For example:<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &amp;lt;servlet&amp;gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *     &amp;lt;servlet-name&amp;gt;My Vaadin App&amp;lt;/servlet-name&amp;gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *     &amp;lt;servlet-class&amp;gt;org.dellroad.stuff.vaadin7.SpringVaadinServlet&amp;lt;/servlet-class&amp;gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *     &amp;lt;init-param&amp;gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *         &amp;lt;param-name&amp;gt;UI&amp;lt;/param-name&amp;gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> *         &amp;lt;param-value&amp;gt;com.example.MyApplicationUI&amp;lt;/param-value&amp;gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *     &amp;lt;/init-param&amp;gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *     &amp;lt;init-param&amp;gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> *         &amp;lt;param-name&amp;gt;configLocation&amp;lt;/param-name&amp;gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *         &amp;lt;param-value&amp;gt;classpath:com/example/MyApplicationContext.xml&amp;lt;/param-value&amp;gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> *     &amp;lt;/init-param&amp;gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &amp;lt;/servlet&amp;gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;/p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * The main function of this servlet is to create and register a {@link SpringVaadinSessionListener} as a listener on the<a name="line.51"></a>
<span class="sourceLineNo">052</span> * {@link com.vaadin.server.VaadinService} associated with this servlet. The {@link SpringVaadinSessionListener} in turn detects<a name="line.52"></a>
<span class="sourceLineNo">053</span> * the creation and destruction of Vaadin application instances (represented by {@link com.vaadin.server.VaadinSession}<a name="line.53"></a>
<span class="sourceLineNo">054</span> * instances) and does the work of managing the associated Spring application contexts.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;/p&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Use of this servlet in place of the standard Vaadin servlet is required for the {@link VaadinConfigurable @VaadinConfigurable}<a name="line.58"></a>
<span class="sourceLineNo">059</span> * annotation to work.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;/p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;p&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * Supported URL parameters:<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &lt;div style="margin-left: 20px;"&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;table border="1" cellpadding="3" cellspacing="0"&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;tr bgcolor="#ccffcc"&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> *  &lt;th align="left"&gt;Parameter Name&lt;/th&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> *  &lt;th align="left"&gt;Required?&lt;/th&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> *  &lt;th align="left"&gt;Description&lt;/th&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;/tr&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;tr&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;td&gt;{@code applicationName}&lt;/td&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;td align="center"&gt;No&lt;/td&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;td&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> *  Vaadin application name. Used for logging purposes and as the name of the XML application context file<a name="line.75"></a>
<span class="sourceLineNo">076</span> *  when {@code configLocation} is not specified. If this parameter is not specified, the<a name="line.76"></a>
<span class="sourceLineNo">077</span> *  name of the servlet is used.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * &lt;/td&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;/tr&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;tr&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;td&gt;{@code configLocation}&lt;/td&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * &lt;td align="center"&gt;No&lt;/td&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;td&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> *  Location of Spring application context XML file(s). Multiple locations are separated by whitespace.<a name="line.84"></a>
<span class="sourceLineNo">085</span> *  If omitted, {@code /WEB-INF/ServletName.xml} is used, where {@code ServletName} is the name of the Vaadin<a name="line.85"></a>
<span class="sourceLineNo">086</span> *  application (see {@code applicationName}).<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;/td&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;/tr&gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;tr&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;td&gt;{@code listenerClass}&lt;/td&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;td align="center"&gt;No&lt;/td&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;td&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> *  Specify the name of a custom class extending {@link SpringVaadinSessionListener} and having the same constructor arguments.<a name="line.93"></a>
<span class="sourceLineNo">094</span> *  If omitted, {@link SpringVaadinSessionListener} is used.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * &lt;/td&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> * &lt;/tr&gt;<a name="line.96"></a>
<span class="sourceLineNo">097</span> * &lt;tr&gt;<a name="line.97"></a>
<span class="sourceLineNo">098</span> * &lt;td&gt;{@code sessionTracking}&lt;/td&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;td align="center"&gt;No&lt;/td&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> * &lt;td&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span> *  Boolean value that configures whether the {@link SpringVaadinSessionListener} should track Vaadin sessions; default<a name="line.101"></a>
<span class="sourceLineNo">102</span> *  {@code false}. If set to {@code true}, then {@link #getSessions} can be used to access all active sessions.<a name="line.102"></a>
<span class="sourceLineNo">103</span> *  Session tracking should not be used unless sessions are normally kept in memory; e.g., don't use session tracking<a name="line.103"></a>
<span class="sourceLineNo">104</span> *  when sessions are being serialized and persisted. See also {@link VaadinSessionContainer}.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * &lt;/td&gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;/tr&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * &lt;tr&gt;<a name="line.107"></a>
<span class="sourceLineNo">108</span> * &lt;td&gt;{@code maxSessions}&lt;/td&gt;<a name="line.108"></a>
<span class="sourceLineNo">109</span> * &lt;td align="center"&gt;No&lt;/td&gt;<a name="line.109"></a>
<span class="sourceLineNo">110</span> * &lt;td&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span> *  Configures a limit on the number of simultaneous Vaadin sessions that may exist at one time. Going over this<a name="line.111"></a>
<span class="sourceLineNo">112</span> *  limit will result in a {@link com.vaadin.server.ServiceException} being thrown. A zero or negative number<a name="line.112"></a>
<span class="sourceLineNo">113</span> *  means there is no limit (this is the default). Ignored unless {@value #SESSION_TRACKING_PARAMETER} is set to {@code true}.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * &lt;/td&gt;<a name="line.114"></a>
<span class="sourceLineNo">115</span> * &lt;/tr&gt;<a name="line.115"></a>
<span class="sourceLineNo">116</span> * &lt;/table&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span> * &lt;/div&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;/p&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * &lt;p&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span> * Note: if any beans are declared {@code scope="session"} in your application context, you must register Spring's<a name="line.121"></a>
<span class="sourceLineNo">122</span> * {@link org.springframework.web.context.request.RequestContextListener} as a listener in your {@code web.xml}<a name="line.122"></a>
<span class="sourceLineNo">123</span> * (normally, Spring's {@link org.springframework.web.servlet.DispatcherServlet} would handle this task).<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;/p&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> *<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @see SpringVaadinSessionListener<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @see VaadinConfigurable<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @see VaadinApplication<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span>@SuppressWarnings("serial")<a name="line.130"></a>
<span class="sourceLineNo">131</span>public class SpringVaadinServlet extends VaadinServlet {<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /**<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * Servlet initialization parameter (&lt;code&gt;{@value #CONFIG_LOCATION_PARAMETER}&lt;/code&gt;) used to specify<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * the location(s) of the Spring application context XML file(s). Multiple XML files may be separated by whitespace.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * This parameter is optional.<a name="line.136"></a>
<span class="sourceLineNo">137</span>     */<a name="line.137"></a>
<span class="sourceLineNo">138</span>    public static final String CONFIG_LOCATION_PARAMETER = "configLocation";<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>    /**<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * Servlet initialization parameter (&lt;code&gt;{@value #LISTENER_CLASS_PARAMETER}&lt;/code&gt;) used to specify<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * the name of an custom subclass of {@link SpringVaadinSessionListener}.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * This parameter is optional.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     */<a name="line.144"></a>
<span class="sourceLineNo">145</span>    public static final String LISTENER_CLASS_PARAMETER = "listenerClass";<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>    /**<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * Servlet initialization parameter (&lt;code&gt;{@value #APPLICATION_NAME_PARAMETER}&lt;/code&gt;) used to specify<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * the name the application.<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * This parameter is optional.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     */<a name="line.151"></a>
<span class="sourceLineNo">152</span>    public static final String APPLICATION_NAME_PARAMETER = "applicationName";<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span>    /**<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * Servlet initialization parameter (&lt;code&gt;{@value #SESSION_TRACKING_PARAMETER}&lt;/code&gt;) that enables<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * tracking of all Vaadin session.<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * This parameter is optional, and defaults to &lt;code&gt;false&lt;/code&gt;.<a name="line.157"></a>
<span class="sourceLineNo">158</span>     */<a name="line.158"></a>
<span class="sourceLineNo">159</span>    public static final String SESSION_TRACKING_PARAMETER = "sessionTracking";<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>    /**<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * Servlet initialization parameter (&lt;code&gt;{@value #MAX_SESSIONS_PARAMETER}&lt;/code&gt;) that configures the<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * maximum number of simultaneous Vaadin sessions. Requires {@link #SESSION_TRACKING_PARAMETER} to be set to {@code true}.<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * This parameter is optional, and defaults to zero, which means no limit.<a name="line.164"></a>
<span class="sourceLineNo">165</span>     */<a name="line.165"></a>
<span class="sourceLineNo">166</span>    public static final String MAX_SESSIONS_PARAMETER = "maxSessions";<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>    // We use weak references to avoid leaks caused by exceptions in SessionInitListeners; see http://dev.vaadin.com/ticket/12915<a name="line.168"></a>
<span class="sourceLineNo">169</span>    private final WeakHashMap&lt;VaadinSession, Void&gt; liveSessions = new WeakHashMap&lt;&gt;();<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span>    private String servletName;<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>    @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span>    public void init(ServletConfig config) throws ServletException {<a name="line.174"></a>
<span class="sourceLineNo">175</span>        this.servletName = config.getServletName();<a name="line.175"></a>
<span class="sourceLineNo">176</span>        if (this.servletName == null)<a name="line.176"></a>
<span class="sourceLineNo">177</span>            throw new IllegalArgumentException("null servlet name");<a name="line.177"></a>
<span class="sourceLineNo">178</span>        super.init(config);<a name="line.178"></a>
<span class="sourceLineNo">179</span>    }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span>    @Override<a name="line.181"></a>
<span class="sourceLineNo">182</span>    protected void servletInitialized() throws ServletException {<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span>        // Sanity check<a name="line.184"></a>
<span class="sourceLineNo">185</span>        if (this.servletName == null)<a name="line.185"></a>
<span class="sourceLineNo">186</span>            throw new IllegalArgumentException("servlet not initialized");<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span>        // Defer to superclass<a name="line.188"></a>
<span class="sourceLineNo">189</span>        super.servletInitialized();<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span>        // Get params<a name="line.191"></a>
<span class="sourceLineNo">192</span>        final VaadinServletService servletService = this.getService();<a name="line.192"></a>
<span class="sourceLineNo">193</span>        final Properties params = servletService.getDeploymentConfiguration().getInitParameters();<a name="line.193"></a>
<span class="sourceLineNo">194</span>        final String contextLocation = params.getProperty(CONFIG_LOCATION_PARAMETER);<a name="line.194"></a>
<span class="sourceLineNo">195</span>        final String listenerClassName = params.getProperty(LISTENER_CLASS_PARAMETER);<a name="line.195"></a>
<span class="sourceLineNo">196</span>        String applicationName = params.getProperty(APPLICATION_NAME_PARAMETER);<a name="line.196"></a>
<span class="sourceLineNo">197</span>        if (applicationName == null)<a name="line.197"></a>
<span class="sourceLineNo">198</span>            applicationName = this.servletName;<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span>        // Detect listener class to use<a name="line.200"></a>
<span class="sourceLineNo">201</span>        Class&lt;? extends SpringVaadinSessionListener&gt; listenerClass = SpringVaadinSessionListener.class;<a name="line.201"></a>
<span class="sourceLineNo">202</span>        if (listenerClassName != null) {<a name="line.202"></a>
<span class="sourceLineNo">203</span>            try {<a name="line.203"></a>
<span class="sourceLineNo">204</span>                listenerClass = Class.forName(listenerClassName, false, Thread.currentThread().getContextClassLoader())<a name="line.204"></a>
<span class="sourceLineNo">205</span>                  .asSubclass(SpringVaadinSessionListener.class);<a name="line.205"></a>
<span class="sourceLineNo">206</span>            } catch (RuntimeException e) {<a name="line.206"></a>
<span class="sourceLineNo">207</span>                throw e;<a name="line.207"></a>
<span class="sourceLineNo">208</span>            } catch (Exception e) {<a name="line.208"></a>
<span class="sourceLineNo">209</span>                throw new ServletException("error finding class " + listenerClassName, e);<a name="line.209"></a>
<span class="sourceLineNo">210</span>            }<a name="line.210"></a>
<span class="sourceLineNo">211</span>        }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span>        // Create session listener<a name="line.213"></a>
<span class="sourceLineNo">214</span>        SpringVaadinSessionListener sessionListener;<a name="line.214"></a>
<span class="sourceLineNo">215</span>        try {<a name="line.215"></a>
<span class="sourceLineNo">216</span>            sessionListener = listenerClass.getConstructor(String.class, String.class)<a name="line.216"></a>
<span class="sourceLineNo">217</span>              .newInstance(applicationName, contextLocation);<a name="line.217"></a>
<span class="sourceLineNo">218</span>        } catch (RuntimeException e) {<a name="line.218"></a>
<span class="sourceLineNo">219</span>            throw e;<a name="line.219"></a>
<span class="sourceLineNo">220</span>        } catch (Exception e) {<a name="line.220"></a>
<span class="sourceLineNo">221</span>            throw new ServletException("error instantiating " + listenerClass, e);<a name="line.221"></a>
<span class="sourceLineNo">222</span>        }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span>        // Register session listener<a name="line.224"></a>
<span class="sourceLineNo">225</span>        servletService.addSessionInitListener(sessionListener);<a name="line.225"></a>
<span class="sourceLineNo">226</span>        servletService.addSessionDestroyListener(sessionListener);<a name="line.226"></a>
<span class="sourceLineNo">227</span>    }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span>    @Override<a name="line.229"></a>
<span class="sourceLineNo">230</span>    protected VaadinServletService createServletService(DeploymentConfiguration deploymentConfiguration) throws ServiceException {<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span>        // Get session tracking parameters<a name="line.232"></a>
<span class="sourceLineNo">233</span>        final Properties params = deploymentConfiguration.getInitParameters();<a name="line.233"></a>
<span class="sourceLineNo">234</span>        final boolean sessionTracking = Boolean.valueOf(params.getProperty(SESSION_TRACKING_PARAMETER));<a name="line.234"></a>
<span class="sourceLineNo">235</span>        int maxSessionsParam = 0;<a name="line.235"></a>
<span class="sourceLineNo">236</span>        try {<a name="line.236"></a>
<span class="sourceLineNo">237</span>            maxSessionsParam = Integer.parseInt(params.getProperty(MAX_SESSIONS_PARAMETER));<a name="line.237"></a>
<span class="sourceLineNo">238</span>        } catch (Exception e) {<a name="line.238"></a>
<span class="sourceLineNo">239</span>            // ignore<a name="line.239"></a>
<span class="sourceLineNo">240</span>        }<a name="line.240"></a>
<span class="sourceLineNo">241</span>        final int maxSessions = maxSessionsParam;<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span>        // If not tracking sessions, do the normal thing<a name="line.243"></a>
<span class="sourceLineNo">244</span>        if (!sessionTracking)<a name="line.244"></a>
<span class="sourceLineNo">245</span>            return super.createServletService(deploymentConfiguration);<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span>        // Return a VaadinServletService that tracks sessions<a name="line.247"></a>
<span class="sourceLineNo">248</span>        final VaadinServletService service = new VaadinServletService(this, deploymentConfiguration) {<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span>            @Override<a name="line.250"></a>
<span class="sourceLineNo">251</span>            protected VaadinSession createVaadinSession(VaadinRequest request) throws ServiceException {<a name="line.251"></a>
<span class="sourceLineNo">252</span>                final VaadinSession session;<a name="line.252"></a>
<span class="sourceLineNo">253</span>                synchronized (SpringVaadinServlet.this.liveSessions) {<a name="line.253"></a>
<span class="sourceLineNo">254</span>                    if (maxSessions &gt; 0 &amp;&amp; SpringVaadinServlet.this.liveSessions.size() &gt;= maxSessions)<a name="line.254"></a>
<span class="sourceLineNo">255</span>                        throw new ServiceException("The maximum number of active sessions has been reached");<a name="line.255"></a>
<span class="sourceLineNo">256</span>                    session = super.createVaadinSession(request);<a name="line.256"></a>
<span class="sourceLineNo">257</span>                    SpringVaadinServlet.this.liveSessions.put(session, null);<a name="line.257"></a>
<span class="sourceLineNo">258</span>                }<a name="line.258"></a>
<span class="sourceLineNo">259</span>                return session;<a name="line.259"></a>
<span class="sourceLineNo">260</span>            }<a name="line.260"></a>
<span class="sourceLineNo">261</span><a name="line.261"></a>
<span class="sourceLineNo">262</span>            @Override<a name="line.262"></a>
<span class="sourceLineNo">263</span>            public void fireSessionDestroy(VaadinSession session) {<a name="line.263"></a>
<span class="sourceLineNo">264</span>                synchronized (SpringVaadinServlet.this.liveSessions) {<a name="line.264"></a>
<span class="sourceLineNo">265</span>                    SpringVaadinServlet.this.liveSessions.remove(session);<a name="line.265"></a>
<span class="sourceLineNo">266</span>                }<a name="line.266"></a>
<span class="sourceLineNo">267</span>                super.fireSessionDestroy(session);<a name="line.267"></a>
<span class="sourceLineNo">268</span>            }<a name="line.268"></a>
<span class="sourceLineNo">269</span>        };<a name="line.269"></a>
<span class="sourceLineNo">270</span>        service.init();<a name="line.270"></a>
<span class="sourceLineNo">271</span>        return service;<a name="line.271"></a>
<span class="sourceLineNo">272</span>    }<a name="line.272"></a>
<span class="sourceLineNo">273</span><a name="line.273"></a>
<span class="sourceLineNo">274</span>    /**<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * Get all live {@link VaadinSession}s associated with this instance.<a name="line.275"></a>
<span class="sourceLineNo">276</span>     *<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * @return live tracked sessions, or an empty collection if session tracking is not enabled<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * @see VaadinSessionContainer<a name="line.278"></a>
<span class="sourceLineNo">279</span>     */<a name="line.279"></a>
<span class="sourceLineNo">280</span>    public List&lt;VaadinSession&gt; getSessions() {<a name="line.280"></a>
<span class="sourceLineNo">281</span>        synchronized (this.liveSessions) {<a name="line.281"></a>
<span class="sourceLineNo">282</span>            return new ArrayList&lt;VaadinSession&gt;(this.liveSessions.keySet());<a name="line.282"></a>
<span class="sourceLineNo">283</span>        }<a name="line.283"></a>
<span class="sourceLineNo">284</span>    }<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span>    /**<a name="line.286"></a>
<span class="sourceLineNo">287</span>     * Get the {@link SpringVaadinServlet} that is associated with the given {@link VaadinSession}.<a name="line.287"></a>
<span class="sourceLineNo">288</span>     *<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * @throws IllegalStateException if the {@link VaadinServlet} associated with {@code session} is not a<a name="line.289"></a>
<span class="sourceLineNo">290</span>     *  {@link SpringVaadinServlet}<a name="line.290"></a>
<span class="sourceLineNo">291</span>     */<a name="line.291"></a>
<span class="sourceLineNo">292</span>    public static SpringVaadinServlet getServlet(VaadinSession session) {<a name="line.292"></a>
<span class="sourceLineNo">293</span>        if (session == null)<a name="line.293"></a>
<span class="sourceLineNo">294</span>            throw new IllegalArgumentException("null session");<a name="line.294"></a>
<span class="sourceLineNo">295</span>        if (!(session.getService() instanceof VaadinServletService))<a name="line.295"></a>
<span class="sourceLineNo">296</span>            throw new IllegalStateException("the VaadinService associated with the session is not a VaadinServletService instance");<a name="line.296"></a>
<span class="sourceLineNo">297</span>        final VaadinServletService service = (VaadinServletService)session.getService();<a name="line.297"></a>
<span class="sourceLineNo">298</span>        if (!(service.getServlet() instanceof SpringVaadinServlet))<a name="line.298"></a>
<span class="sourceLineNo">299</span>            throw new IllegalStateException("the VaadinServlet associated with the session is not a SpringVaadinServlet instance");<a name="line.299"></a>
<span class="sourceLineNo">300</span>        return (SpringVaadinServlet)service.getServlet();<a name="line.300"></a>
<span class="sourceLineNo">301</span>    }<a name="line.301"></a>
<span class="sourceLineNo">302</span>}<a name="line.302"></a>
<span class="sourceLineNo">303</span><a name="line.303"></a>




























































</pre>
</div>
</body>
</html>
